001    /*
002     * Copyright (c) 2005 Stephen J. McConnell
003     *
004     * Licensed  under the  Apache License,  Version 2.0  (the "License");
005     * you may not use  this file  except in  compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *   http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed  under the  License is distributed on an "AS IS" BASIS,
012     * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
013     * implied.
014     *
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package net.dpml.component;
020    
021    import java.io.File;
022    import java.util.EventObject;
023    
024    /**
025     * The ControllerContextEvent is an abstract base class for working and 
026     * temporty directory change notification events.
027     *
028     * @author <a href="http://www.dpml.net">Digital Product Meta Library</a>
029     * @version 1.0.1
030     */
031    public abstract class ControllerContextEvent extends EventObject
032    {
033       /**
034        * Serial version identifier.
035        */
036        static final long serialVersionUID = 1L;
037    
038        private ControllerContext m_context;
039        private File m_old;
040        private File m_new;
041    
042       /**
043        * Creation of a new controller context event object.
044        *
045        * @param source the controller context initiating the event
046        * @param oldDir the original directory value
047        * @param newDir the new directory value
048        */
049        public ControllerContextEvent( ControllerContext source, File oldDir, File newDir )
050        {
051            super( source );
052            m_context = source;
053            m_old = oldDir;
054            m_new = newDir;
055        }
056    
057       /**
058        * Return the controller context that this event is related to.
059        * @return the controller context
060        */
061        public ControllerContext getContext()
062        {
063            return m_context;
064        }
065    
066       /**
067        * Return the old directory value.
068        * @return the directory
069        */
070        public File getOldDirectory()
071        {
072            return m_old;
073        }
074    
075       /**
076        * Return the new directory value.
077        * @return the directory
078        */
079        public File getNewDirectory()
080        {
081            return m_new;
082        }
083    }